/*
 * nlsync
 * Copyright (c) 2010 apechurin 
 * 
 * Permission is hereby granted, free of charge, to any person
 * obtaining a copy of this software and associated documentation
 * files (the "Software"), to deal in the Software without
 * restriction, including without limitation the rights to use,
 * copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following
 * conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 */
using System;
using System.Collections.Generic;
using System.Text;

namespace nlsync
{
    /// <summary>
    /// Represents a single localizable string. It provides following
    /// information about a string:
    /// - the string name (aka id);
    /// - the default string value (optional, can be null);
    /// - the string value itself;
    /// - the string comment.
    /// All properties can throw Exception in a error case.
    /// </summary>
    public interface IStringInfo
    {
        /// <summary>
        /// Gets the name. It cannot be changed.
        /// </summary>
        string Name
        {
            get;
        }

        /// <summary>
        /// Gets/sets the default value. get can return null.
        /// set can throw an exception if not supported.
        /// </summary>
        string DefaultValue
        {
            get;
            set;
        }

        /// <summary>
        /// Gets/sets the value.
        /// </summary>
        string Value
        {
            get;
            set;
        }

        /// <summary>
        /// Gets/sets the comment.
        /// </summary>
        string Comment
        {
            get;
            set;
        }
    }
}
